home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / thelp.arc / READ.ME < prev    next >
Text File  |  1991-05-03  |  5KB  |  93 lines
  1.  
  2.  
  3.                                    THELP
  4.  
  5.     THELP is a very simple method of designing and calling your own custom
  6.     help screens from within Telix:  either with a function key or by
  7.     running them as a script file.  Included are two sample programs with
  8.     matching help screens and templates.  They are basically the same
  9.     program but I wanted to demo two options and show what variables
  10.     need adjustment when changing the size of the help screen.
  11.  
  12.             File list:
  13.  
  14.             READ.ME       What you are reading now...
  15.             THELP.SLT     SALT program for showing full-screen help screen
  16.             THELP.SLC     Compiled THELP.SLT
  17.             CIS.HLP       Sample Compuserve help screen for THELP
  18.             BLANK.HLP     Template for creating full-screen help screens.
  19.  
  20.             THELP2.SLT    SALT program for showing half-screen help screen
  21.             THELP2.SLC    Compiled THELP2.SLT
  22.             CIS2.HLP      Sample Compuserve help screen for THELP2
  23.             BLANK2.HLP    Template for creating half-screen help screens.
  24.  
  25.     First, try out the two help screens included.  Move them to your Telix
  26.     directory (they must be in the Telix directory unless you include the
  27.     full path name in the program.)  Press Alt-G to run a script file
  28.     and type in THELP.  At the bottom of the help screen you will see a
  29.     message saying "Esc to Restore Screen or Any Key for Terminal Mode".
  30.     What this means is that Esc will restore what was on the screen before
  31.     and return you to terminal mode.  Any Other Key will return you to
  32.     terminal mode with the help screen intact.  The 2nd option is more
  33.     useful when you are NOT using a full-help screen and you want to be
  34.     able to read the help screen as you type in a command in terminal
  35.     mode.  Since your cursor spends most of the time at the bottom of
  36.     the screen in terminal mode, a half-screen help screen at the top
  37.     works well in many situations.  Press Alt-G and type THELP2 to
  38.     check out the half-screen help screen.
  39.  
  40.     To run a one of these programs using a function key, press Alt-K in
  41.     Telix mode which will bring up the keyboard options.  Choose edit a
  42.     key and press the key you want to use.  For example, choose F1 and
  43.     then type @THELP. (Don't type the period, though.)   When you return
  44.     to terminal mode, F1 should call THELP.
  45.  
  46.     To design your own help screen, you can either use one of the
  47.     templates or start from scratch.  Use an ASCII text editor, keep
  48.     lines from being longer than 80 characters and the number of lines
  49.     at 24 or less.
  50.  
  51.     If you choose to use one of the templates, you will need to change
  52.     the variable fname[] to the name of your help file.  It is better
  53.     to use the full pathname for this so that you can access it is
  54.     you are not in the telix directory.
  55.  
  56.     If you want to change the number of lines or the postion, you will
  57.     need to dig a little deeper into the code.  The programs have
  58.     more detailed explanation but the following is a complete list of
  59.     variables that you need or want to customize.  Especially check out
  60.     THELP2 because it points out which variables had to be changed from
  61.     THELP.
  62.  
  63.     str buf[size];   array to store screen in - size should be
  64.                      (number of lines) * 160 (includes char and
  65.                       attribute}
  66.  
  67.     int lines;                     //  number of lines of text in file
  68.     int color;                     // change this to suit your tastes
  69.     str fname[67] = "cis2.hlp";    // name of your help screen file
  70.     int c;                         //  column position to start
  71.     int r;                         //  row position to start
  72.  
  73.  
  74.     If you have never used SALT, remember that after you change any
  75.     part of the SALT programs, you will need to recompile the program.
  76.     Syntax is: CS prognam
  77.     Example:   CS THELP         will compile and create THELP.SLC
  78.  
  79.  
  80.  -----------------------------  Notes  -------------------------------
  81.  
  82.  
  83.    These script files are just some ideas that might be helpful to
  84.    someone else in using Telix and/or learning SALT.  SALT is an
  85.    excellent language and worth learning...it is a good starting
  86.    point for learning C, among other things.  These script files
  87.    have been tested using Telix 3.15.
  88.  
  89.                                          Larry Dresser
  90.  
  91.    These programs are not guaranteed to work, etc.., etc.., more legalese,
  92.     ... they are just figments of your imagination.
  93.